/* This file is part of the Palabos library.
 *
 * The Palabos softare is developed since 2011 by FlowKit-Numeca Group Sarl
 * (Switzerland) and the University of Geneva (Switzerland), which jointly
 * own the IP rights for most of the code base. Since October 2019, the
 * Palabos project is maintained by the University of Geneva and accepts
 * source code contributions from the community.
 *
 * Contact:
 * Jonas Latt
 * Computer Science Department
 * University of Geneva
 * 7 Route de Drize
 * 1227 Carouge, Switzerland
 * jonas.latt@unige.ch
 *
 * The most recent release of Palabos can be downloaded at
 * <https://palabos.unige.ch/>
 *
 * The library Palabos is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * The library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/** \file
 * Dirichlet boundary condition which imposes equilibrium (but computes
 * density properly from velocity, or vice versa)
 */
#ifndef EQUILIBRIUM_BOUNDARY_DYNAMICS_H
#define EQUILIBRIUM_BOUNDARY_DYNAMICS_H

#include "boundaryCondition/boundaryDynamics.h"
#include "core/globalDefs.h"

namespace plb {

/// Equilibrium velocity boundary dynamics for a straight wall.
template <typename T, template <typename U> class Descriptor, int direction, int orientation>
class EquilibriumVelocityBoundaryDynamics :
    public VelocityDirichletBoundaryDynamics<T, Descriptor, direction, orientation> {
public:
    EquilibriumVelocityBoundaryDynamics(
        Dynamics<T, Descriptor> *baseDynamics_, bool automaticPrepareCollision = true);

    /// Clone the object, based on its dynamic type
    virtual EquilibriumVelocityBoundaryDynamics<T, Descriptor, direction, orientation> *clone()
        const;

    /// Return a unique ID for this class.
    virtual int getId() const;

    /// Execute completion scheme before base collision
    virtual void completePopulations(Cell<T, Descriptor> &cell) const;

private:
    static int id;
};

/// Equilibrium density Dirichlet boundary dynamics for a straight wall.
template <typename T, template <typename U> class Descriptor, int direction, int orientation>
class EquilibriumDensityBoundaryDynamics :
    public DensityDirichletBoundaryDynamics<T, Descriptor, direction, orientation> {
public:
    EquilibriumDensityBoundaryDynamics(
        Dynamics<T, Descriptor> *baseDynamics_, bool automaticPrepareCollision = true);

    /// Clone the object, based on its dynamic type
    virtual EquilibriumDensityBoundaryDynamics<T, Descriptor, direction, orientation> *clone()
        const;

    /// Return a unique ID for this class.
    virtual int getId() const;

    /// Execute completion scheme before base collision
    virtual void completePopulations(Cell<T, Descriptor> &cell) const;

private:
    static int id;
};

/// Equilibrium boundary dynamics, on which both density and velocity are imposed.
template <typename T, template <typename U> class Descriptor>
class EquilibriumDensityAndVelocityBoundaryDynamics :
    public StoreDensityAndVelocityDynamics<T, Descriptor> {
public:
    EquilibriumDensityAndVelocityBoundaryDynamics(
        Dynamics<T, Descriptor> *baseDynamics_, bool automaticPrepareCollision);

    /// Clone the object, based on its dynamic type
    virtual EquilibriumDensityAndVelocityBoundaryDynamics<T, Descriptor> *clone() const;

    /// Return a unique ID for this class.
    virtual int getId() const;

    /// Execute completion scheme before base collision
    virtual void completePopulations(Cell<T, Descriptor> &cell) const;

private:
    static int id;
};

}  // namespace plb

#endif  // EQUILIBRIUM_BOUNDARY_DYNAMICS_H
